@types/estree

What is @types/estree?

The @types/estree package provides TypeScript type definitions for the ESTree spec, which is a specification for representing JavaScript source code as an abstract syntax tree (AST). These type definitions allow TypeScript developers to work with ASTs in a type-safe manner, ensuring that the structure of the tree is consistent with the ESTree specification.

What are @types/estree's main functionalities?

Defining AST Node Types

This code sample represents a simple AST for a JavaScript program that declares a constant variable 'x' with the value 10. The @types/estree package provides the types that describe the structure of this AST.

{"type": "Program","sourceType": "module","body": [{"type": "VariableDeclaration","declarations": [{"type": "VariableDeclarator","id": {"type": "Identifier","name": "x"},"init": {"type": "Literal","value": 10,"raw": "10"}}],"kind": "const"}]}

Type Checking AST Nodes

This code sample demonstrates how to use the Node type from @types/estree to type-check an AST node and handle it accordingly based on its type.

import { Node } from 'estree';
function processNode(node: Node) {
  if (node.type === 'BinaryExpression') {
    // Handle binary expression
  }
}

Other packages similar to @types/estree

acorn

Acorn is a JavaScript parser that produces an AST based on the ESTree specification. While @types/estree provides type definitions, Acorn provides the actual parsing functionality to generate ASTs from JavaScript code.

espree

Espree is an ECMAScript parser that is built on top of Acorn. Similar to Acorn, it outputs an AST conforming to the ESTree spec. Espree extends Acorn with additional features and ES6+ support.

babel-types

Babel-types is a part of the Babel compiler that provides builders, validators, and converters for Babel's AST, which is slightly different from the ESTree spec. It serves a similar purpose to @types/estree but for Babel's AST format.

README

Installation

npm install --save @types/estree

Summary

This package contains type definitions for ESTree AST specification (https://github.com/estree/estree).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/estree.

Additional Details

• Last updated: Mon, 11 Jan 2021 22:13:25 GMT
• Dependencies: none
• Global values: none

Credits

These definitions were written by RReverser.